<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>wdtps: xwdtps_polled_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">wdtps
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xwdtps__polled__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xwdtps_polled_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains a design example using the System Watchdog Timer driver (<a class="el" href="struct_x_wdt_ps.html" title="The XWdtPs driver instance data. ">XWdtPs</a>) and hardware device. </p>
<p>This function assumes that the reset output of the Watchdog timer device is not connected to the reset of the processor.</p>
<dl class="section note"><dt>Note</dt><dd></dd></dl>
<p>None.</p>
<p>MODIFICATION HISTORY:</p>
<pre>
  Ver   Who    Date     Changes
</p>
<hr/>
<p>
  1.00a ecm/jz 01/15/10 First release
  3.6   sb     06/27/23 Added support for system device-tree flow.
*</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:af6d8744c28d965bc0522023a8fb10053"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xwdtps__polled__example_8c.html#af6d8744c28d965bc0522023a8fb10053">WdtPsPolledExample</a> (u16 DeviceId)</td></tr>
<tr class="memdesc:af6d8744c28d965bc0522023a8fb10053"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function does a minimal test on the System Watchdog Timer device and driver as a design example.  <a href="#af6d8744c28d965bc0522023a8fb10053">More...</a><br/></td></tr>
<tr class="separator:af6d8744c28d965bc0522023a8fb10053"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xwdtps__polled__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:a840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function to call the Wdt polled mode example.  <a href="#a840291bc02cba5474a4cb46a9b9566fe">More...</a><br/></td></tr>
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a840291bc02cba5474a4cb46a9b9566fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function to call the Wdt polled mode example. </p>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, XST_FAILURE if unsuccessful</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>References <a class="el" href="xwdtps__polled__example_8c.html#af6d8744c28d965bc0522023a8fb10053">WdtPsPolledExample()</a>.</p>

</div>
</div>
<a class="anchor" id="af6d8744c28d965bc0522023a8fb10053"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int WdtPsPolledExample </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function does a minimal test on the System Watchdog Timer device and driver as a design example. </p>
<p>The purpose of this function is to illustrate how to use the <a class="el" href="struct_x_wdt_ps.html" title="The XWdtPs driver instance data. ">XWdtPs</a> driver.</p>
<p>This function assumes that the reset output of the Watchdog timer device is not connected to the reset of the processor. The function allows the Watchdog Timer to timeout such that a reset will occur if it is connected. If the interrupt output is connected to an interrupt input, the user must handle the interrupts appropriately if the output is enabled.</p>
<p>This function may require some time (seconds or even minutes) to execute because it waits for the Watchdog Timer to expire.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>is the unique device id of the device.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, otherwise XST_FAILURE.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_wdt_ps___config.html#ab09dc2a13ed7882ec309278ebc43b16c">XWdtPs_Config::BaseAddress</a>, <a class="el" href="group__wdtps.html#ga9c5980e1118cff3e565fcc1f3b6e140a">XWDTPS_CCR_PSCALE_0008</a>, <a class="el" href="group__wdtps.html#gaf5315b5d46aba7c4d02b988740d44c66">XWdtPs_CfgInitialize()</a>, <a class="el" href="group__wdtps.html#ga4182ead880093d17d2b0962839821929">XWDTPS_CLK_PRESCALE</a>, <a class="el" href="group__wdtps.html#gac055573454d39a7fadf5cbd1ed19aea5">XWDTPS_COUNTER_RESET</a>, <a class="el" href="group__wdtps.html#ga0d6091a8ee48e49031cf0c8c92a87658">XWdtPs_DisableOutput()</a>, <a class="el" href="group__wdtps.html#ga5ad51ea203fc3eb20ecd848117c2f930">XWdtPs_IsWdtExpired</a>, <a class="el" href="group__wdtps.html#ga4b447b33afe318703da0f9f96849ee41">XWdtPs_LookupConfig()</a>, <a class="el" href="group__wdtps.html#gad0b2439fb19478f1b1c1d14b76cd15cc">XWDTPS_RESET_SIGNAL</a>, <a class="el" href="group__wdtps.html#ga89baace72a7b8abe477a8cfed4606a08">XWdtPs_RestartWdt</a>, <a class="el" href="group__wdtps.html#ga64f2de6079bde6e9b8c495401a555a64">XWdtPs_SetControlValue()</a>, and <a class="el" href="group__wdtps.html#ga2ac689cec0d17cc916c509285635135b">XWdtPs_Start()</a>.</p>

<p>Referenced by <a class="el" href="xwdtps__polled__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
